chore: add pre-commit hook for prettier + eslint #32
Conversation
There was a problem hiding this comment.
One thing I "like" (it might be just that I'm used to it, it can be annoying though when you're making multiple commits in one go by staging parts of files) when using pre-commit is that when a formatter makes a change, it aborts the commit and you have to stage the new changes before committing again, while this changes the staged file (not sure how this works, maybe just immediately staging the lines that were affected?) and doesn't neccesarily make it clear it made changes before letting you enter a commit message (assuming no -m). This causes some slightly weird things when staging only parts of files when you might want more control. I'm undecided if this should block this though, especially with husky being the standard tool for this (not sure if lint-staged is responsible for this behaviour or husky). My tests weren't super realistic though, this may be a non issue in a more standard file.
| } | ||
| }, | ||
| "lint-staged": { | ||
| "*.{js,jsx,ts,tsx,md,mdx,yml,json}": "prettier --write", |
There was a problem hiding this comment.
yaml isn't included here. Is this intentional (and trying to set a standard of using yml)?
There was a problem hiding this comment.
Nope, I'll add yaml. Was just following the pattern that the only yaml files in the project currently are yml but they're both totally fine.
|
My personal workflow utilizes heavy partial staging for atomic commits, and I haven't noticed an issue with this on any of the projects that I contribute to with the same or similar setups. From what I could find in the |
|
I would feel more comfortable using pre-commit, as that's what I have experience with and know the ecosystem around (not to mention it's already used in the backend repo), but I'm also not opposed to using husky if it's what's better known in the javascript world. That being said, I do have some questions left unanswered after skimming through husky docs:
One more thing that I find particularly annoying is if this workaround is an actual requirement |
We could probably add a
Not sure if you can just use cmd or PowerShell but if not we could recommend WSL since that seems to be what a lot of devs on Windows are using now, especially with the WSL support in VSCode. Also #38 would also help but users wouldn't be able to use a git GUI other than VSCode's if they're used to it (although maybe they support using a custom shell?). Even then you could use the GUI, just not for actually committing. My workflow at the moment is a mix between |
Closes #30
This change adds a pre-commit hook via
huskyandlint-staged, which enables the configured tasks to be run on staged changes. With this configuration,prettierandeslintare run on their respective files.